cboj-payments-prc-api
Terminate Standing Order
Description:
This API terminates or cancels an already created standing order.
Mulesoft Request:
Headers:
Mandatory Headers: x-channel-id,x-client-trace-id, x-bank-id,client_id, client_secret
Optional Headers: x-sub-channel-id,x-user-id, Authorization, x-debug-flag, x-customer-id
Paramaters:
URI Params: 'ftReference'
Query Params: NA
Content-type: application/json
Body:
```
{
"ftRef": "4000218.2",
"action": "PROCESS",
"debitAccount": "4165253",
"type": "FI",
"payMethod": "OTAC",
"currency": "JOD",
"payAmount": "101",
"creditAccount": "1000006",
"currentFrequency": "20220531 e0Y e0M e0W e1D e0F",
"currentEndDate": "20220601",
"ftVersion": "FUNDS.TRANSFER?CBOJ.FCC.ACH.STO",
"beneficiaryAccountNumber": "JO03EFBK0010000000000004143697",
"chargesType": "SHA",
"beneficiaryName": "TESTING1",
"purposeCode": "0101",
"beneficiaryAddress": "Beneficiary Address",
"beneficiaryCountry": "JO",
"remitanceInfo": "TESTING PAYMENT DETAIL REMIT INFO",
"relation": "205",
"recievingCountry": "GDI",
"intermediateBank": "CBOJ",
"acctountWithBank": [
"HBHOJOAXXXX"
],
"accountWithBankAccount": "",
"sgBulkVal": "",
"channelId": "",
"channelRef": ""
}
Mulesoft Response:
Success Response: (200)
{
"response": {
"ftReference": "4165253.173"
},
"status": {
"status": true,
"code": 201,
"arabicMsg": "تمت العملية بنجاØ",
"englishMsg": "The Operation has been Successfully Completed"
}
}
```
Sample Error Response:
Please refer the HOME page for all possible combinations of error response codes.
Note: The 'errorCode' and 'backendErrorMessage' will be in the error response message only if 'x-debug-flag' is '1'
404 :
{
"status": {
"success": false,
"code": "T24003799",
"reasonCode": "",
"arabicMessage": "NO SIGN ON NAME SUPPLIED DURING SIGN ON PROCESS",
"englishMessage": "NO SIGN ON NAME SUPPLIED DURING SIGN ON PROCESS",
"errorCode": "T24003799",
"errorDescription": "INVALID/ NO SIGN ON NAME SUPPLIED DURING SIGN ON PROCESS"
}
}